12.8 给终端设置标签
请求参数
Path： /api/v1/device/setTag
Method： POST
接口描述：
- 给终端设置指定的标签。
- 支持以 追加，覆盖 两种方式，对终端设置标签。
- 若标签不存在，则新增。
- 接口适用于 v2.2.9 及以上版本。
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 必须 |
Body
根据 externalId 对终端设置标签
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| externalId | string | 必须 | 外部ID | 基于 externalId 匹配待修改终端 | |
| tagList | string[] | 必须 | 标签 | 若标签不存在，则自动创建此标签 | |
| isAppend | number | 非必须 | 1 | 标签更新方式 | 标签是否追加更新：0-覆盖更新，1-追加更新 |
请求示例
{
"externalId": "0c4e9039-f81d-11ec-a760-fefcfe545bb7",
"tagList": ["开发测试终端", "办公网终端"],
"isAppend": 1,
}
根据 mac 对终端设置标签
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| mac | string | 必须 | MAC地址 | 匹配到多条终端时报错 | |
| tagList | string[] | 必须 | 标签 | 若标签不存在，则自动创建此标签 | |
| isAppend | number | 非必须 | 1 | 标签更新方式 | 标签是否追加更新：0-覆盖更新，1-追加更新 |
请求示例
{
"mac": "FE-FC-FE-21-F5-D1",
"tagList": ["开发测试终端", "办公网终端"],
"isAppend": 1,
}
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | number | 必须 | 错误码，非0表示失败 | ||
| data | object | 必须 | 响应数据 | ||
| msg | string | 必须 | 描述信息 | ||
| traceId | string | 必须 | 调用链ID，链路请求的标识 |
返回示例
{
"code": 0,
"data": {},
"msg": "请求成功",
"traceId": "0022c672e4c8b0d6"
}
错误信息
| 错误提示 | 错误码 |
|---|---|
| MAC地址格式错误 | 7201 |
| 外部ID中不能含有非法的特殊字符：换行符，制表符，回车符 | 7201 |
| 外部ID长度超过最大上限：%d | 7201 |
| 请输入标签 | 7201 |
| 标签只允许输入中文、字母、数字、下划线和横杠 | 7201 |
| 标签最多可输入%d个字 | 7201 |
| 标签更新方式参数值错误，应该为: [0, 1] | 7201 |
| 请输入匹配参数 | 10000001 |
| 请勿输入多个匹配参数: %s | 10000001 |
| 终端不存在 | 77200001 |
| 匹配到多条终端，请求失败 | 37400404 |
| 当前终端可选标签数量已达上限: %d | 37400405 |
| 无法新增标签(%s)，最多可存在%d个标签 | 37400406 |